home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / arca05.zip / ARCA.DOC < prev    next >
Text File  |  1989-03-10  |  20KB  |  492 lines
  1.  
  2.    ▐▒▒▒▒▒▒ ▐▒▒▒▒▒▒ ▐▒▒▒▒▒▒ ▐▒▒▒▒▒▒ ** S    I M U L    A T O R       version 2.01
  3.    ▐▒▒ ▐▒▒ ▐▒▒ ▐▒▒ ▐▒▒       ▐▒▒ ▐▒▒    ──────────────────────────────────
  4.    ▐▒▒▒▒▒▒ ▐▒▒▒▒▒▒ ▐▒▒       ▐▒▒▒▒▒▒      Copyrighted (C) 1989 by
  5.    ▐▒▒ ▐▒▒ ▐▒▒ ▐▒  ▐▒▒       ▐▒▒ ▐▒▒          TRI-SYSTEMS co.
  6.    ▐▒▒ ▐▒▒ ▐▒▒ ▐▒▒ ▐▒▒▒▒▒▒ ▐▒▒ ▐▒▒    Written    by Johan Zwiekhorst
  7.    ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  8.  
  9. Usage: ARCA [Drive:][Path]ArchiveName[.ARC] [Drive:][Path]FileName[.Ext] [/D]
  10.  
  11. /D will    delete files after adding to archive
  12. filenames may contain *    and ? wildcards
  13.  
  14. (**Original ARCA copyrighted (C) 1986 by Wayne Chin and    Vernon Buerg)
  15.  
  16.  
  17. (****************************************************************************
  18. * REVISION HISTORY                                *
  19. * ~~~~~~~~~~~~~~~~                                *
  20. * 2.01 - Patch to allow    TABs in    the configuration file - I just    forgot!        *
  21. * 2.00 - Completely rewritten (Turbo Pascal 5.00); the ARCA*Simulator now   *
  22. *     uses a    configuration file ARCA.CFG for    dertermining which archiver *
  23. *     program should    be used    for each fidonet node in order to create    *
  24. *     compressed mail bundles.  Any archiver    program    can be supported.   *
  25. *---------------------------------------------------------------------------*
  26. * 1.20 - It is now required that the ARCA*Simulator be in the same directory*
  27. *     as PKARC.  The    name PKPAK is now recognized, too.            *
  28. *     Bug fix: there    was a problem when the commandline for the        *
  29. *     ARCA*Simulator    was more than 116 characters long.            *
  30. * 1.10 - /D switch now requires    a version of PKARC which can handle the        *
  31. *     (m)ove    to archive command.                        *
  32. * 1.01 - Bug fix: /D switch with filespec=*.* caused the archive to be        *
  33. *     deleted, too.                                *
  34. * 1.00 - Base version                                *
  35. ****************************************************************************)
  36.  
  37. ╒════════════╕
  38. │ 1. GENERAL │
  39. ╘════════════╛
  40.  
  41. This FREEWARE program is intended to replace the original ARCA.COM program by
  42. Wayne Chin and Vernon Buerg in order to    use _any_ archiver program for
  43. compressing mail bundles: the purpose of this is, to allow the use of better
  44. and faster compression techniques than those provided by the original ARCA.
  45.  
  46. Note, that this    version    of the ARCA*Simulator uses a configuration file
  47. (ARCA.CFG) in order to determine which archiver    should be used for compressing
  48. mail for each fidonet node you exchange    mail with.
  49. The ARCA*Simulator lets    you specify a default archiver to be used for all
  50. nodes not mentioned in the configuration file.
  51. I suggest that you rename the original ARCA to OARCA.COM and specify that one
  52. to be used as the default archiver.
  53.  
  54. Sysops who wish    to have    the ability to extract ANY kind    of mailarchive they
  55. might receive, could perhaps examine my    GUS program.
  56. GUS (General Unpack Shell) can extract ARC, PAK, DWC, ZOO and ZIP archives.
  57. It is obtainable as GUS01.ZIP on many BBSs. Note that the '01' designates a
  58. release    number,    and increases with every new release.
  59.  
  60. The ARCA*Simulator will    occupy close to    20K of memory when it is running.
  61. Note, that the ARCA*Simulator will call    another    program    to do the actual
  62. compression of the mail, which will make the total amount of memory occupied
  63. larger than the    amount mentioned before.
  64. Consult    the archiver program's documentation in    order to find out how much
  65. memory it requires to run.
  66. Please see to it that you have enough memory left when the ARCA*Simulator is
  67. run, or    you may    not be able to compress    your mail.
  68. In the latter case, the    mail packet files will remain untouched    on your    drive.
  69.  
  70. If an error occurs during the compression of your mail,    the ARCA*Simulator
  71. will halt with an errorlevel of    1 or greater (it will use the errorlevel
  72. returned by the    archiver program) and mail packets will    NEVER be deleted.
  73. (At least not by the ARCA*Simulator.)
  74.  
  75. If no error occurred, the ARCA*Simulator will return with an errorlevel    of
  76. zero and mail packets will be deleted if the /D    switch was specified.
  77. ------------------------------------------------------------------------------
  78.  
  79. Usage:
  80. ~~~~~~
  81.       ARCA [Drive:][Path]ArchiveName[.ARC] [Drive:][Path]FileName[.Ext]    [/D]
  82.  
  83. /D will    delete files after adding to archive
  84. filenames may contain *    and ? wildcards
  85.  
  86. Note, that the optional    delete switch (/D) may also be used first on the
  87. commandline, in    order to be compatible with echomail processors    which require
  88. the archiver to    have the command first on the commandline.
  89. Note also, that    it is possible to use more than    one filename to    be archived on
  90. the same commandline, and that wildcards are allowed.
  91. Wildcards are not allowed in the archive name, however.
  92.  
  93. USAGE FOR oMMM:
  94. ~~~~~~~~~~~~~~~
  95. For oMMM versions below    1.10, you don't    have to    do anything, it    will use the
  96. ARCA*Simulator correctly.  Just    rename ARCA.COM    to OARCA.COM.
  97. For oMMM versions 1.10 and higher, you will have to specify that ARCA should
  98. be used    for archiving and _not_    PKARC or ZOO.  Rename ARCA.COM to OARCA.COM
  99. also.
  100.  
  101. USAGE FOR QEcho    (QuickBBS):
  102. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  103. In your    QEcho.Ctl file,    you should specify
  104.  
  105.     ArcCommand   ARCA
  106.  
  107. or    ArcCommand   ARCA /D
  108.  
  109. The latter is not necessary, however, since QEcho will kill the    mail packets
  110. itself if the archiver didn't do it.
  111. You probably didn't use    the original ARCA.COM, so you will have    to specify
  112. «PKARC -oct -a»    for the    default    archiver (see later).
  113.  
  114. USAGE FOR OTHER    MAIL PROCESSORS:
  115. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  116. Consult    the documentation for your mail    processor.  Most processors use    a
  117. configuration or control file in which you can specify which archiver to use.
  118. You may    refer to the example for the QEcho mail    processor for QuickBBS above.
  119.  
  120.  
  121. ╒═══════════════════════╕
  122. │ 2. CONFIGURATION FILE    │
  123. ╘═══════════════════════╛
  124.  
  125. The configuration file for the ARCA*Simulator is called    ARCA.CFG and _must_ be
  126. located    in the SAME directory as the ARCA*Simulator itself.
  127.  
  128. The configuration file contains    four kinds of information:
  129. comments, keyword definitions, an identification and directives.
  130.  
  131. The order in which they    appear is irrelevant, except that directives MUST
  132. appear LAST in the configuration file!
  133.  
  134. Also important:    each entry must    occupy a line by itself.
  135.  
  136. You can    study the configuration    file supplied with this    program    for an example
  137. of how to compose that file.
  138. Perhaps    the easiest way    is to just modify that file so that it suits your
  139. needs, instead of constructing a new one.
  140. The supplied configuration file    contains keyword definitions for all popular
  141. archiver programs.
  142.  
  143. 1) comments
  144. ~~~~~~~~~~~
  145. Anything after a ';' sign is considered    a comment and thus ignored.
  146.  
  147. 2) keyword definitions
  148. ~~~~~~~~~~~~~~~~~~~~~~
  149. A keyword definition is    composed as follows:
  150.  
  151.     #def «keyword»
  152.       #prg «archiver_filespec»
  153.      [#apc]
  154.      [#ext «req'd_extension»]
  155.       #add «add_command»
  156.       #mov «move_command»
  157.     #end
  158.  
  159. So, a keyword definition begins    with a '#def' entry and    ends with an '#end'
  160. entry.    The «keyword» is a unique word of maximum 8 LETTERS.  The keyword will
  161. be used    to designate one specific archiver program.  The keyword definition
  162. will hence have    to contain all information necessary to    run the    archiver
  163. program    in question.
  164.  
  165. The keyword "DEFAULT" is reserved for indicating which archiver    should be used
  166. by default.  So, a keyword definition for "DEFAULT" _must_ be present.
  167.  
  168. Blanks are ignored, so the indentation of the lines between '#def' and '#end'
  169. was done for legibility    and has    no other meaning.
  170. The order of the lines between '#def' and '#end' may be    chosen arbitrary,
  171. since that is not important.
  172. Note, however, that the    '#prg',    '#add' and '#mov' entries MUST be present,
  173. while the '#apc' and '#ext' entries are    optional.
  174. That's what the    square brackets    '[' and    ']' are    for: they serve    to indicate
  175. that the enclosed entries are optional and should themselves not be typed.
  176. The same goes for the '«' and '»' characters: they indicate a description
  177. which must be replaced by an actual parameter, and should themselves not be
  178. typed, too.
  179.  
  180. The '#prg' entry defines the full path and filename of the archiver program
  181. designated by the keyword.
  182.